Resource StructureDefinition/FHIR Server from package nictiz.fhir.nl.dstu2.zib2015#1.0.0 (344 ms)
Resources that use this resource
Resources that this resource uses
Source
{
"resourceType" : "StructureDefinition",
"id" : "nl-core-address",
"meta" : {
"versionId" : "6",
"lastUpdated" : "2017-03-07T14:05:16.595+00:00"
},
"url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address",
"version" : "1.0",
"name" : "nl-core-address",
"status" : "draft",
"publisher" : "HL7 Netherlands",
"description" : "Base StructureDefinition for Address Type with additions for Dutch realm addresses. Dutch addresses break down Address.line in several parts and it is important to mark an address as being 'officially registered'.",
"copyright" : "CC0",
"fhirVersion" : "1.0.2",
"mapping" : [
{
"identity" : "zib-address",
"uri" : "https://zibs.nl/wiki/Patient(NL)",
"name" : "Address as part of Zorginformatiebouwsteen Patient"
},
{
"identity" : "BRP",
"uri" : "https://nl.wikipedia.org/wiki/Basisregistratie_Personen",
"name" : "Basisregistratie Personen",
"comments" : "Voorheen GBA - Gemeentelijke basisregistratie"
}
],
"kind" : "datatype",
"constrainedType" : "Address",
"abstract" : false,
"base" : "http://hl7.org/fhir/StructureDefinition/Address",
"differential" : {
"element" : [
{
"id" : "Address",
"path" : "Address",
"short" : "A physical/postal address",
"definition" : "There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses. \r\n\r\nA Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\nTo have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.",
"alias" : [
"adres"
],
"type" : [
{
"code" : "Address"
}
],
"exampleAddress" : {
"extension" : [
{
"url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean" : false
}
],
"line" : [
"Binnenkant 12A Hoog"
],
"_line" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString" : "Binnenkant"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString" : "12"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
"valueString" : "A"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID",
"valueString" : "Hoog"
}
]
}
],
"city" : "Amsterdam",
"state" : "NH",
"postalCode" : "1000AA",
"country" : "NLD"
},
"condition" : [
"nl-streetname-if-official-and-other-line-parts"
],
"constraint" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression",
"valueString" : "extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').valueBoolean.where(true).empty() or line.where( extension.url in ('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber' | 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix' | 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator') and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty).empty"
}
],
"key" : "nl-streetname-if-official-and-other-line-parts",
"requirements" : "This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address",
"severity" : "error",
"human" : "Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value",
"xpath" : "not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])"
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.4"
}
]
},
{
"id" : "Address.extension",
"path" : "Address.extension",
"slicing" : {
"discriminator" : [
"url"
],
"rules" : "open"
}
},
{
"id" : "Address.extension.official",
"path" : "Address.extension",
"name" : "official",
"short" : "Mark an address as an 'officially registered' address.",
"definition" : "Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP)",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.11"
}
]
},
{
"id" : "Address.line",
"path" : "Address.line"
},
{
"id" : "Address.line.extension",
"path" : "Address.line.extension",
"slicing" : {
"discriminator" : [
"url"
],
"rules" : "open"
}
},
{
"id" : "Address.line.extension.streetName",
"path" : "Address.line.extension",
"name" : "streetName",
"requirements" : "Basisregistratie Persoonsgegevens 11.10 Straatnaam",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.12"
},
{
"identity" : "BRP",
"map" : "11.10 Straatnaam"
}
]
},
{
"id" : "Address.line.extension.houseNumber",
"path" : "Address.line.extension",
"name" : "houseNumber",
"requirements" : "Basisregistratie Persoonsgegevens 11.20 Huisnummer",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.13"
},
{
"identity" : "BRP",
"map" : "11.20 Huisnummer"
}
]
},
{
"id" : "Address.line.extension.buildingNumbersuffix",
"path" : "Address.line.extension",
"name" : "buildingNumberSuffix",
"definition" : "HouseNumberLetter - A letter following the house number as assigned by the municipal authorities.\r\nHouseNumberAddition - The letters or signs needed to locate the mailbox, in addition to the house number and letter.",
"requirements" : "Basisregistratie Persoonsgegevens 11.30 Huisletter\r\n11.40 Huisnummertoevoeging\r\n12.10 Locatieomschrijving",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.40"
},
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.41"
},
{
"identity" : "BRP",
"map" : "11.30 Huisletter"
},
{
"identity" : "BRP",
"map" : "11.40 Huisnummertoevoeging"
}
]
},
{
"id" : "Address.line.extension.unitID",
"path" : "Address.line.extension",
"name" : "unitID",
"definition" : "Extra information such as the building name, building number, entrance, route number.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.28"
}
]
},
{
"id" : "Address.line.extension.additionalLocator",
"path" : "Address.line.extension",
"name" : "additionalLocator",
"definition" : "HouseNumberIndication - The indication used for addresses which do not consist of the usual street name and house number.",
"requirements" : "Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
]
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.42"
},
{
"identity" : "BRP",
"map" : "11.50 Aanduiding bij huisnummer"
}
]
},
{
"id" : "Address.city",
"path" : "Address.city",
"short" : "Name of city, town etc.",
"definition" : "The name of the city, town, village or other community or delivery center.",
"requirements" : "Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam",
"alias" : [
"Municipality",
"woonplaats"
],
"exampleString" : "Den Haag",
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.14"
},
{
"identity" : "BRP",
"map" : "11.70 Woonplaatsnaam"
}
]
},
{
"id" : "Address.district",
"path" : "Address.district",
"short" : "District name (aka county)",
"definition" : "The name of the administrative area (county).",
"comments" : "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. In a Dutch address this element is used for the population of a \"gemeente\"",
"requirements" : "Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving",
"alias" : [
"County",
"gemeente"
],
"exampleString" : "Wateringen",
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.16"
},
{
"identity" : "BRP",
"map" : "09.10 Gemeente van inschrijving"
}
]
},
{
"id" : "Address.state",
"path" : "Address.state",
"short" : "Sub-unit of country (abbreviations ok).",
"definition" : "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). For Dutch addresses this element should contain the \"provincie\" code",
"requirements" : "Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel).",
"alias" : [
"Province",
"Territory",
"provincie"
],
"exampleString" : "ZH"
},
{
"id" : "Address.postalCode",
"path" : "Address.postalCode",
"short" : "Postal code for area",
"definition" : "A postal code designating a region defined by the postal service.",
"comments" : "Dutch postal codes have pattern '\\d{4}[A-Z]{2}' so they do not have spaces. Systems can easily render postal codes with a space if necessary.",
"alias" : [
"Zip",
"postcode"
],
"exampleString" : "9132AG",
"condition" : [
"nl-postal-code-pattern"
],
"constraint" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression",
"valueString" : "(country in 'nl' | 'nld' | 'nederland').not() or matches('^\\\\d{4}[A-Z]{2}$')"
}
],
"key" : "nl-postal-code-pattern",
"severity" : "error",
"human" : "Dutch postal code pattern 'nnnnAA'",
"xpath" : "not(../f:country[lower-case(@value)=('nl','nld','nederland')]) or matches(@value,'^\\d{4}[A-Z]{2}$')"
}
],
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.15"
},
{
"identity" : "BRP",
"map" : "11.60 Postcode"
}
]
},
{
"id" : "Address.country",
"path" : "Address.country",
"short" : "Country (can be ISO 3166 3 letter code)",
"definition" : "A country (code) for the address.",
"alias" : [
"land"
],
"exampleString" : "NLD",
"mapping" : [
{
"identity" : "zib-address",
"map" : "NL-CM:0.1.17"
}
]
}
]
},
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.
FHIR